R/f - Names.R

In pieterov/generaltoolbox: General toolbox by Pieter Overdevest

#' @title Give names of data frame.
#'
#' @description Gives names of data frame.
#'
#' @author Pieter Overdevest
#'
#' @param df.input Data frame to get names of.
#' @param b.sort.name Should names be sorted? (default: TRUE).
#' @param b.sort.class Should types be sorted? (default: TRUE).
#'
#' @returns Nothing.
#'
#' @details -
#'
#' @export
#'
#' @examples
#' f_names(
#'
#'        df.input     = mtcars,
#'        b.sort.name  = TRUE,
#'        b.sort.class = TRUE
#' )


        #################################################################################
        # FUNCTION.
        #################################################################################

        f_names <- function(

                df.input,
                b.sort.name  = TRUE,
                b.sort.class = TRUE
        ) {


        ##############################################################################
        # TEST ONLY!!
        ##############################################################################

        # df.input <- data.frame(pieter = c("sd", "sd", "ds", "ds", "sd"),
        #                 x = c("", "na", "N/A", 0, NA),
        #                 y = c(1,2,3,4,5),
        #                 w = as.factor(c("ioo","oioi", "oio", "oio", "ioo")))

        # df.input <- df.temp1


        ##############################################################################
        # Initialize // Error checking.
        ##############################################################################

        # Check that input is data frame.
        if (!any(class(df.input) == "data.frame"))

                stop("Input should be data frame.")


        if (identical(names(df.input), character(0))) {

                warning("Data frame has no names.")

                return(cat(""))

        }


        ##############################################################################
        # Analyse data.
        ##############################################################################

        # Print header.
        cat("\nBasic Info Data Frame:\n\n")

        # Create basic info data frame.
        df.basic.info <- data.frame(Name  = c("=============", names(df.input)),
                                    Class = c("=============", unlist(sapply(df.input, function(x) paste(class(x), collapse = "; "))))
                                    )

        if (b.sort.name) {

                if (b.sort.class) {

                        df.basic.info <- df.basic.info %>% arrange(Class, Name)
                } else {

                        df.basic.info <- df.basic.info %>% arrange(Name)
                }
        }


        rownames(df.basic.info) <- c("", seq(nrow(df.basic.info)-1))

        # Show in console, left align.
        print(x          = df.basic.info,
              #row.names = FALSE,
              right      = FALSE)

        }